API Reference (IPS version: 16.5 Update 34 (16.5.34))
Important: For correct API reference information, you should ensure that the version of this document matches with the version of your IPS server. See the version number in the heading and 'Software version' in every page footer.
The topics in this section contain API reference information for three APIs: 'IPS Manager', 'IPS License Server', and 'IPS Server Monitor'.
For version 16.5 Update 13 and later: The Server Monitor API, and also the tenant-level endpoint, can be disabled using the IPS service setting 'Enable Server Monitor'. When disabled, all back-end data collection and API endpoints are stopped; and the Server Monitor user interfaces in IPS Manager and Planning Space are removed.
HTTP methods used by the Admin API
The API implements the following HTTP methods for its operations, based on the conventions for RESTful API design:
| Method | Description |
|---|---|
| GET | Retrieves a resource. |
| POST | Creates a new resource or performs an action on the specified resource. |
| PUT | Replaces or updates an existing resource. |
| PATCH | Performs a partial update on an existing resource (that is, only changes are sent in the API request). |
IPS Server Monitor Tenant API (tenant-level endpoint)
The IPS Server Monitor API is also accessible at a tenant-level endpoint, and can be used by any tenant user. See 'IPS Server Monitor Tenant API' in the Planning Space Web API Guide.
How to use the API Reference
Click the API name in the left-hand menu to display all of that API's resource groups and operations. Alternatively, use the topic links below.